Skip to content

Integrate sphinx-sitemap for generating a sitemap in Jupyter Book.#382

Open
github-actions[bot] wants to merge 7 commits into
mainfrom
git-bob-mod-Ge83Dphnds
Open

Integrate sphinx-sitemap for generating a sitemap in Jupyter Book.#382
github-actions[bot] wants to merge 7 commits into
mainfrom
git-bob-mod-Ge83Dphnds

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

@github-actions github-actions Bot commented Nov 6, 2024

This message was generated by git-bob (version: 0.14.0, model: github_models:gpt-4o, log), an experimental AI-based assistant. It can make mistakes and has limitations. Check its messages carefully.

To enhance the search engine discoverability of our Jupyter Book hosted on GitHub Pages, we integrated the sphinx-sitemap extension. In the docs/_config.yml, we added the sphinx_sitemap extension and configured it with the appropriate site_url. Additionally, we updated the requirements.txt to include the sphinx-sitemap as a new dependency, ensuring that the sitemap is generated during the build process.

  • docs/_config.yml Added configuration for sphinx_sitemap extension to enable sitemap generation.
  • requirements.txt Added sphinx-sitemap to the list of required packages.

closes #381

@haesleinhuepf
Copy link
Copy Markdown
Member

There was an error when building the Jupyter book:

File "/opt/hostedtoolcache/Python/3.12.7/x64/lib/python3.12/site-packages/sphinx/config.py", line 272, in __getattr__
    raise AttributeError(__('No such config value: %s') % name)
AttributeError: No such config value: use_multitoc_numbering

git-bob comment on how to fix this

@github-actions
Copy link
Copy Markdown
Contributor Author

github-actions Bot commented Nov 6, 2024

This message was generated by git-bob (version: 0.14.0, model: github_models:gpt-4o, log), an experimental AI-based assistant. It can make mistakes and has limitations. Check its messages carefully.

The changes made in the pull request align with the discussion regarding the integration of the sphinx-sitemap extension. The docs/_config.yml file was updated to include the sphinx_sitemap extension and the necessary configurations, while requirements.txt now lists sphinx-sitemap as a dependency.

Regarding the build error raised by @haesleinhuepf, it appears unrelated to the changes for the sphinx-sitemap integration. The error might be due to the use_multitoc_numbering being specified somewhere in the configuration. Please check your conf.py or any related configuration files for use_multitoc_numbering and ensure it's correctly defined according to Sphinx's current documentation or implemented features. If the option isn't required, you might consider removing it. If further issues persist, consulting updated references or documentation for configurations in Jupyter Book and Sphinx would be a good next step.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add sitemap

1 participant